/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.ejb.deployment.descriptor;

import java.io.Serializable;
import java.lang.reflect.Field;


/** 
 * This class stores information about CMP and Foreign Key fields.
 * Note: the "field" variable is only available at runtime.
 *
 * @author Sanjeev Krishnan
 */

public final class PersistentFieldInfo implements Serializable {

    public PersistentFieldInfo() {}

    public PersistentFieldInfo(PersistentFieldInfo other) {
        field       = other.field;
        name        = other.name;
        type        = other.type;
        relatedName = other.relatedName;
        relatedObj  =  other.relatedObj;
    }

    public transient Field field;
    public String name;
    public transient Class type;

    // For fkey fields (including fields in Join objects) 
    // these two fields are the corresponding pkey field and related object, 
    // For CMP fields these are null.
    public String relatedName; 
    public PersistenceDescriptor relatedObj; 
}
